Node / meshtastic / Meshtastic-Android / files / core / database / src / jvmTest / kotlin / org / meshtastic / core / database / MeshtasticDatabaseMigrationTest.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.core.database

Tff7b72import T7ee787androidx.room3.testing.MigrationTestHelper

Tff7b72import T7ee787androidx.sqlite.SQLiteConnection

Tff7b72import T7ee787androidx.sqlite.driver.bundled.BundledSQLiteDriver

Tff7b72import T7ee787androidx.sqlite.execSQL

Tff7b72import T7ee787kotlinx.coroutines.test.runTest

Tff7b72import T7ee787java.io.File

Tff7b72import T7ee787kotlin.io.path.Path

Tff7b72import T7ee787kotlin.test.AfterTest

Tff7b72import T7ee787kotlin.test.Test

Tff7b72import T7ee787kotlin.test.assertEquals

T8b949e/**

* Creates the earliest exported schema (v3) and walks every auto-migration up to the current version, validating the

* resulting schema against the exported JSON at each step. This is the guard that a broken migration would trip

* *before* users hit [MeshtasticDatabase]'s `fallbackToDestructiveMigration(dropAllTables = false)`, which would

* otherwise silently wipe their data.

*

* Runs on the JVM target — so it is part of `:core:database:allTests` and executes in PR CI. The JVM

* [MigrationTestHelper] reads the exported schemas straight from the module's `schemas/` directory, so no APK/asset

* packaging is needed (unlike the instrumented `androidDeviceTest` variant, which does not run in the PR pipeline).

*/

Tff7b72class T56d364MeshtasticDatabaseMigrationTest Tb4b4b4{

T8b949e// The JVM MigrationTestHelper resolves schemas relative to the Gradle test working directory (the module dir).

Tff7b72private Tff7b72val Te6edf3schemaDir Tff7b72= Te6edf3PathTb4b4b4(Ta5d6ff"Ta5d6ffschemasTa5d6ff"Tb4b4b4)

Tff7b72private Tff7b72val Te6edf3dbFile Tff7b72= Te6edf3FileTb4b4b4.Te6edf3createTempFileTb4b4b4(Ta5d6ff"Ta5d6ffmeshtastic-migrationTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff.dbTa5d6ff"Tb4b4b4)Tb4b4b4.Te6edf3apply Tb4b4b4{ Te6edf3deleteTb4b4b4(Tb4b4b4) Tb4b4b4}

T8b949e// Not wired as a @Rule: jvmTest runs on the JUnit Platform, where JUnit4 @Rule does not apply. Connections are

T8b949e// closed inline instead.

Tff7b72private Tff7b72val Te6edf3helper Tff7b72=

Te6edf3MigrationTestHelperTb4b4b4(

Te6edf3schemaDirectoryPath Tff7b72= Te6edf3schemaDirTb4b4b4,

Te6edf3databasePath Tff7b72= Te6edf3dbFileTb4b4b4.Te6edf3toPathTb4b4b4(Tb4b4b4)Tb4b4b4,

Te6edf3driver Tff7b72= Te6edf3BundledSQLiteDriverTb4b4b4(Tb4b4b4)Tb4b4b4,

Te6edf3databaseClass Tff7b72= Te6edf3MeshtasticDatabaseTff7b72::Te6edf3classTb4b4b4,

Te6edf3databaseFactory Tff7b72= Tb4b4b4{ Te6edf3MeshtasticDatabaseConstructorTb4b4b4.Te6edf3initializeTb4b4b4(Tb4b4b4) Tb4b4b4}Tb4b4b4,

Tb4b4b4)

Tf0883e@AfterTest

Tff7b72fun Td2a8ffcleanUpTb4b4b4(Tb4b4b4) Tb4b4b4{

Te6edf3dbFileTb4b4b4.Te6edf3deleteTb4b4b4(Tb4b4b4)

Tb4b4b4}

Tf0883e@Test

Tff7b72fun Td2a8ffmigrateAllTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3runTest Tb4b4b4{

Te6edf3helperTb4b4b4.Te6edf3createDatabaseTb4b4b4(Te6edf3EARLIEST_SCHEMA_VERSIONTb4b4b4)Tb4b4b4.Te6edf3closeTb4b4b4(Tb4b4b4)

T8b949e// No manual migrations: every version bump is an @AutoMigration, so Room derives the full path itself.

Te6edf3helperTb4b4b4.Te6edf3runMigrationsAndValidateTb4b4b4(Te6edf3latestSchemaVersionTb4b4b4(Tb4b4b4)Tb4b4b4, Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4)Tb4b4b4.Te6edf3closeTb4b4b4(Tb4b4b4)

Tb4b4b4}

T8b949e/**

* 50→51 makes the three `rssi` columns nullable, which Room implements by recreating `packet`, `reactions` and

* `discovered_node` (DROP + RENAME). [migrateAll] only proves the resulting schema validates from an empty

* database; this proves existing rows survive the rebuild with their values — including a legacy `rssi = 0`, which

* stays 0 rather than becoming NULL.

*/

Tf0883e@Test

Tff7b72fun Td2a8ffrssiColumnsGoNullableWithoutLosingRowsTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3runTest Tb4b4b4{

Te6edf3helperTb4b4b4.Te6edf3createDatabaseTb4b4b4(Te6edf3RSSI_NULLABLE_FROM_VERSIONTb4b4b4)Tb4b4b4.Te6edf3use Tb4b4b4{ Te6edf3connection Tff7b72-Tff7b72>

Te6edf3connectionTb4b4b4.Te6edf3execSQLTb4b4b4(

Ta5d6ff"Ta5d6ffINSERT INTO packet (uuid, myNodeNum, port_num, contact_key, received_time, read, data, snr, rssi) Ta5d6ff" Tff7b72+

Ta5d6ff"Ta5d6ffVALUES (1, 42, 1, '0^all', 1000, 1, '{}', 5.0, 0)Ta5d6ff"Tb4b4b4,

Tb4b4b4)

Te6edf3connectionTb4b4b4.Te6edf3execSQLTb4b4b4(

Ta5d6ff"Ta5d6ffINSERT INTO reactions (myNodeNum, reply_id, user_id, emoji, timestamp, snr, rssi) Ta5d6ff" Tff7b72+

Ta5d6ff"Ta5d6ffVALUES (42, 7, '!abc', 'X', 2000, 5.0, -70)Ta5d6ff"Tb4b4b4,

Tb4b4b4)

Te6edf3connectionTb4b4b4.Te6edf3execSQLTb4b4b4(

Ta5d6ff"Ta5d6ffINSERT INTO discovery_session (id, timestamp, presets_scanned, home_preset) Ta5d6ff" Tff7b72+

Ta5d6ff"Ta5d6ffVALUES (1, 3000, 1, 'LONG_FAST')Ta5d6ff"Tb4b4b4,

Tb4b4b4)

Te6edf3connectionTb4b4b4.Te6edf3execSQLTb4b4b4(

Ta5d6ff"Ta5d6ffINSERT INTO discovery_preset_result (id, session_id, preset_name) VALUES (1, 1, 'LONG_FAST')Ta5d6ff"Tb4b4b4,

Tb4b4b4)

Te6edf3connectionTb4b4b4.Te6edf3execSQLTb4b4b4(

Ta5d6ff"Ta5d6ffINSERT INTO discovered_node (id, preset_result_id, node_num, snr, rssi) VALUES (1, 1, 99, 5.0, 0)Ta5d6ff"Tb4b4b4,

Tb4b4b4)

Tb4b4b4}

Te6edf3helperTb4b4b4.Te6edf3runMigrationsAndValidateTb4b4b4(Te6edf3RSSI_NULLABLE_TO_VERSIONTb4b4b4, Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4)Tb4b4b4.Te6edf3use Tb4b4b4{ Te6edf3connection Tff7b72-Tff7b72>

Te6edf3assertEqualsTb4b4b4(Te6edf3listOfTb4b4b4(Ta5d6ff"Ta5d6ff0Ta5d6ff"Tb4b4b4)Tb4b4b4, Te6edf3queryColumnTb4b4b4(Te6edf3connectionTb4b4b4, Ta5d6ff"Ta5d6ffSELECT rssi FROM packetTa5d6ff"Tb4b4b4)Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(Te6edf3listOfTb4b4b4(Ta5d6ff"Ta5d6ff-70Ta5d6ff"Tb4b4b4)Tb4b4b4, Te6edf3queryColumnTb4b4b4(Te6edf3connectionTb4b4b4, Ta5d6ff"Ta5d6ffSELECT rssi FROM reactionsTa5d6ff"Tb4b4b4)Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(Te6edf3listOfTb4b4b4(Ta5d6ff"Ta5d6ff0Ta5d6ff"Tb4b4b4)Tb4b4b4, Te6edf3queryColumnTb4b4b4(Te6edf3connectionTb4b4b4, Ta5d6ff"Ta5d6ffSELECT rssi FROM discovered_nodeTa5d6ff"Tb4b4b4)Tb4b4b4)

T8b949e// The recreate must not have orphaned the cascading FK target.

Te6edf3assertEqualsTb4b4b4(Te6edf3listOfTb4b4b4(Ta5d6ff"Ta5d6ff1Ta5d6ff"Tb4b4b4)Tb4b4b4, Te6edf3queryColumnTb4b4b4(Te6edf3connectionTb4b4b4, Ta5d6ff"Ta5d6ffSELECT preset_result_id FROM discovered_nodeTa5d6ff"Tb4b4b4)Tb4b4b4)

T8b949e// A NULL is now storable where the column was previously NOT NULL DEFAULT 0.

Te6edf3connectionTb4b4b4.Te6edf3execSQLTb4b4b4(Ta5d6ff"Ta5d6ffUPDATE packet SET rssi = NULL WHERE uuid = 1Ta5d6ff"Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(Te6edf3listOfTb4b4b4(Tff7b72nullTb4b4b4)Tb4b4b4, Te6edf3queryColumnTb4b4b4(Te6edf3connectionTb4b4b4, Ta5d6ff"Ta5d6ffSELECT rssi FROM packetTa5d6ff"Tb4b4b4)Tb4b4b4)

Tb4b4b4}

Tb4b4b4}

Tf0883e@Test

Tff7b72fun Td2a8ffsnrColumnsGoNullableWithoutLosingRowsTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3runTest Tb4b4b4{

Te6edf3helperTb4b4b4.Te6edf3createDatabaseTb4b4b4(Te6edf3SNR_NULLABLE_FROM_VERSIONTb4b4b4)Tb4b4b4.Te6edf3use Tb4b4b4{ Te6edf3connection Tff7b72-Tff7b72>

Te6edf3connectionTb4b4b4.Te6edf3execSQLTb4b4b4(

Ta5d6ff"Ta5d6ffINSERT INTO packet (uuid, myNodeNum, port_num, contact_key, received_time, read, data, snr, rssi) Ta5d6ff" Tff7b72+

Ta5d6ff"Ta5d6ffVALUES (1, 42, 1, '0^all', 1000, 1, '{}', 0.0, -70)Ta5d6ff"Tb4b4b4,

Tb4b4b4)

Te6edf3connectionTb4b4b4.Te6edf3execSQLTb4b4b4(

Ta5d6ff"Ta5d6ffINSERT INTO reactions (myNodeNum, reply_id, user_id, emoji, timestamp, snr, rssi) Ta5d6ff" Tff7b72+

Ta5d6ff"Ta5d6ffVALUES (42, 7, '!abc', 'X', 2000, -12.5, -70)Ta5d6ff"Tb4b4b4,

Tb4b4b4)

Tb4b4b4}

Te6edf3helperTb4b4b4.Te6edf3runMigrationsAndValidateTb4b4b4(Te6edf3SNR_NULLABLE_TO_VERSIONTb4b4b4, Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4)Tb4b4b4.Te6edf3use Tb4b4b4{ Te6edf3connection Tff7b72-Tff7b72>

T8b949e// A stored 0 dB must survive the recreate as 0, not become NULL: it is a real reading.

Te6edf3assertEqualsTb4b4b4(Te6edf3listOfTb4b4b4(Ta5d6ff"Ta5d6ff0.0Ta5d6ff"Tb4b4b4)Tb4b4b4, Te6edf3queryColumnTb4b4b4(Te6edf3connectionTb4b4b4, Ta5d6ff"Ta5d6ffSELECT snr FROM packetTa5d6ff"Tb4b4b4)Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(Te6edf3listOfTb4b4b4(Ta5d6ff"Ta5d6ff-12.5Ta5d6ff"Tb4b4b4)Tb4b4b4, Te6edf3queryColumnTb4b4b4(Te6edf3connectionTb4b4b4, Ta5d6ff"Ta5d6ffSELECT snr FROM reactionsTa5d6ff"Tb4b4b4)Tb4b4b4)

T8b949e// A NULL is now storable where the column was previously NOT NULL DEFAULT 0.

Te6edf3connectionTb4b4b4.Te6edf3execSQLTb4b4b4(Ta5d6ff"Ta5d6ffUPDATE packet SET snr = NULL WHERE uuid = 1Ta5d6ff"Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(Te6edf3listOfTb4b4b4(Tff7b72nullTb4b4b4)Tb4b4b4, Te6edf3queryColumnTb4b4b4(Te6edf3connectionTb4b4b4, Ta5d6ff"Ta5d6ffSELECT snr FROM packetTa5d6ff"Tb4b4b4)Tb4b4b4)

Tb4b4b4}

Tb4b4b4}

T8b949e/** Reads one column of every row as a string, with SQL NULL surfaced as Kotlin null. */

Tff7b72private Tff7b72fun Td2a8ffqueryColumnTb4b4b4(Te6edf3connectionTb4b4b4: Te6edf3SQLiteConnectionTb4b4b4, Te6edf3sqlTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Te6edf3ListTff7b72<Tffa657String?Tff7b72> Tff7b72=

Te6edf3connectionTb4b4b4.Te6edf3prepareTb4b4b4(Te6edf3sqlTb4b4b4)Tb4b4b4.Te6edf3use Tb4b4b4{ Te6edf3statement Tff7b72-Tff7b72>

Te6edf3buildList Tb4b4b4{

Tff7b72while Tb4b4b4(Te6edf3statementTb4b4b4.Te6edf3stepTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4{

Te6edf3addTb4b4b4(Tff7b72if Tb4b4b4(Te6edf3statementTb4b4b4.Te6edf3isNullTb4b4b4(T79c0ff0Tb4b4b4)Tb4b4b4) Tff7b72null Tff7b72else Te6edf3statementTb4b4b4.Te6edf3getTextTb4b4b4(T79c0ff0Tb4b4b4)Tb4b4b4)

Tb4b4b4}

Tb4b4b4}

Tb4b4b4}

Tff7b72private Tff7b72fun Td2a8fflatestSchemaVersionTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657Int Tb4b4b4{

Tff7b72val Te6edf3dbSchemas Tff7b72= Te6edf3schemaDirTb4b4b4.Te6edf3resolveTb4b4b4(Te6edf3checkNotNullTb4b4b4(Te6edf3MeshtasticDatabaseTff7b72::Te6edf3classTb4b4b4.Te6edf3qualifiedNameTb4b4b4)Tb4b4b4)Tb4b4b4.Te6edf3toFileTb4b4b4(Tb4b4b4)

Tff7b72return Te6edf3dbSchemas

Tb4b4b4.Te6edf3listFiles Tb4b4b4{ Te6edf3f Tff7b72-Tff7b72> Te6edf3fTb4b4b4.Te6edf3extension Tff7b72=Tff7b72= Ta5d6ff"Ta5d6ffjsonTa5d6ff" Tb4b4b4}

Tff7b72?.Te6edf3mapNotNull Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3nameWithoutExtensionTb4b4b4.Te6edf3toIntOrNullTb4b4b4(Tb4b4b4) Tb4b4b4}

Tff7b72?.Te6edf3maxOrNullTb4b4b4(Tb4b4b4) Tff7b72?: Te6edf3errorTb4b4b4(Ta5d6ff"Ta5d6ffNo exported Room schemas found in Tffd700$Te6edf3dbSchemasTa5d6ff"Tb4b4b4)

Tb4b4b4}

Tff7b72private Tff7b72companion Tff7b72object Tb4b4b4{

Tff7b72const Tff7b72val Te6edf3EARLIEST_SCHEMA_VERSION Tff7b72= T79c0ff3

Tff7b72const Tff7b72val Te6edf3RSSI_NULLABLE_FROM_VERSION Tff7b72= T79c0ff5T79c0ff0

Tff7b72const Tff7b72val Te6edf3RSSI_NULLABLE_TO_VERSION Tff7b72= T79c0ff5T79c0ff1

Tff7b72const Tff7b72val Te6edf3SNR_NULLABLE_FROM_VERSION Tff7b72= T79c0ff5T79c0ff1

Tff7b72const Tff7b72val Te6edf3SNR_NULLABLE_TO_VERSION Tff7b72= T79c0ff5T79c0ff2

Tb4b4b4}

Tb4b4b4}